/*
 * Copyright (c) 2004-2022, University of Oslo
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors 
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.hisp.dhis.dataelement;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;
import com.google.common.collect.Lists;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import org.hisp.dhis.common.BaseDimensionalObject;
import org.hisp.dhis.common.BaseIdentifiableObject;
import org.hisp.dhis.common.DimensionType;
import org.hisp.dhis.common.DimensionalItemObject;
import org.hisp.dhis.common.DxfNamespaces;
import org.hisp.dhis.common.MetadataObject;

/**
 * DataElementGroupSet is a set of DataElementGroups. It is by default exclusive, in the sense that
 * a DataElement can only be a member of one or zero of the DataElementGroups in a
 * DataElementGroupSet.
 *
 * @author Lars Helge Overland
 */
@JacksonXmlRootElement(localName = "dataElementGroupSet", namespace = DxfNamespaces.DXF_2_0)
public class DataElementGroupSet extends BaseDimensionalObject implements MetadataObject {
  private Boolean compulsory = false;

  private List<DataElementGroup> members = new ArrayList<>();

  // -------------------------------------------------------------------------
  // Constructors
  // -------------------------------------------------------------------------

  public DataElementGroupSet() {}

  public DataElementGroupSet(String name) {
    this.name = name;
    this.compulsory = false;
  }

  public DataElementGroupSet(String name, Boolean compulsory) {
    this(name);
    this.compulsory = compulsory;
  }

  public DataElementGroupSet(String name, String description, Boolean compulsory) {
    this(name, compulsory);
    this.description = description;
  }

  public DataElementGroupSet(
      String name, String description, boolean compulsory, boolean dataDimension) {
    this(name, description, compulsory);
    this.dataDimension = dataDimension;
  }

  // -------------------------------------------------------------------------
  // Logic
  // -------------------------------------------------------------------------

  public void addDataElementGroup(DataElementGroup dataElementGroup) {
    members.add(dataElementGroup);
    dataElementGroup.getGroupSets().add(this);
  }

  public void removeDataElementGroup(DataElementGroup dataElementGroup) {
    members.remove(dataElementGroup);
    dataElementGroup.getGroupSets().remove(this);
  }

  public void removeAllDataElementGroups() {
    for (DataElementGroup dataElementGroup : members) {
      dataElementGroup.getGroupSets().remove(this);
    }

    members.clear();
  }

  public Collection<DataElement> getDataElements() {
    List<DataElement> dataElements = new ArrayList<>();

    for (DataElementGroup group : members) {
      dataElements.addAll(group.getMembers());
    }

    return dataElements;
  }

  public DataElementGroup getGroup(DataElement dataElement) {
    for (DataElementGroup group : members) {
      if (group.getMembers().contains(dataElement)) {
        return group;
      }
    }

    return null;
  }

  public Boolean isMemberOfDataElementGroups(DataElement dataElement) {
    for (DataElementGroup group : members) {
      if (group.getMembers().contains(dataElement)) {
        return true;
      }
    }

    return false;
  }

  public Boolean hasDataElementGroups() {
    return members != null && members.size() > 0;
  }

  public List<DataElementGroup> getSortedGroups() {
    List<DataElementGroup> sortedGroups = new ArrayList<>(members);

    Collections.sort(sortedGroups);

    return sortedGroups;
  }

  // -------------------------------------------------------------------------
  // Dimensional object
  // -------------------------------------------------------------------------

  @Override
  @JsonProperty
  @JsonSerialize(contentAs = DimensionalItemObject.class)
  @JacksonXmlElementWrapper(localName = "items", namespace = DxfNamespaces.DXF_2_0)
  @JacksonXmlProperty(localName = "item", namespace = DxfNamespaces.DXF_2_0)
  public List<DimensionalItemObject> getItems() {
    return Lists.newArrayList(members);
  }

  @Override
  public DimensionType getDimensionType() {
    return DimensionType.DATA_ELEMENT_GROUP_SET;
  }

  // -------------------------------------------------------------------------
  // Getters and setters
  // -------------------------------------------------------------------------

  @JsonProperty
  @JacksonXmlProperty(namespace = DxfNamespaces.DXF_2_0)
  public Boolean isCompulsory() {
    if (compulsory == null) {
      return false;
    }

    return compulsory;
  }

  public void setCompulsory(Boolean compulsory) {
    this.compulsory = compulsory;
  }

  @JsonProperty("dataElementGroups")
  @JsonSerialize(contentAs = BaseIdentifiableObject.class)
  @JacksonXmlElementWrapper(localName = "dataElementGroups", namespace = DxfNamespaces.DXF_2_0)
  @JacksonXmlProperty(localName = "dataElementGroup", namespace = DxfNamespaces.DXF_2_0)
  public List<DataElementGroup> getMembers() {
    return members;
  }

  public void setMembers(List<DataElementGroup> members) {
    this.members = members;
  }
}
